kanzi::PinchManipulator Class Reference

Pinch input manipulator recognizes the pinch gesture from incoming touch events. More...

#include <kanzi/core.ui/input/pinch_manipulator.hpp>

Inheritance diagram for kanzi::PinchManipulator:
kanzi::InputManipulator kanzi::Object kanzi::MetaObject kanzi::PropertyObject

Classes

class  FinishedMessageArguments
 Message arguments for pinch gesture finished message. Inherits argument properties from InputManipulator::InputMessageArguments. More...
 
class  MovedMessageArguments
 Message arguments for moved message sent during pan gesture. Inherits argument properties from InputManipulator::InputMessageArguments. More...
 
class  StartedMessageArguments
 Message arguments for pinch gesture started message. Inherits argument properties from InputManipulator::InputMessageArguments. More...
 

Public Member Functions

void setScaleRecognitionThreshold (float threshold)
 Set the threshold the fingers have to move away from each other before scale is recognized. The default value is 5 screen units. More...
 
void setRotationRecognitionThreshold (float threshold)
 Set the threshold the fingers have to rotate around the midpoint before rotation is recognized. The default value is 5 screen units along the circle. More...
 
- Public Member Functions inherited from kanzi::InputManipulator
virtual ~InputManipulator ()
 Destructor. More...
 
void reset ()
 Reset the manipulator. More...
 
void cancel ()
 Notify manipulator of touch canceling. More...
 
State getState () const
 Get the state of the input manipulator. More...
 
void setState (State state)
 Set the state of the input manipulator. More...
 
NodegetAttachedNode () const
 Gets the node to which the input manipulator is attached. More...
 
void requireToFail (InputManipulatorWeakPtr manipulatorToFail)
 Sets the input manipulator that must fail before Kanzi can recognize this input manipulator. More...
 
InputManipulatorWeakPtr getFailManipulator () const
 Gets the fail manipulator. More...
 
InputManipulatorgetDependManipulator () const
 Gets the dependant input manipulator. More...
 
bool isAttached () const
 Tells whether the input manipulator is attached to a node. More...
 
void setReferenceNode (NodeWeakPtr referenceNode)
 Override the attached node as the hit test reference node. More...
 
void setTouchEventRoutingMode (TouchEventRoutingMode mode)
 Sets the touch event routing mode that you want the input manager to use when distributing the touch points to manipulators. More...
 
TouchEventRoutingMode getTouchEventRoutingMode ()
 Returns the current touch event routing mode. More...
 
- Public Member Functions inherited from kanzi::Object
 Object (Domain *domain)
 
virtual ~Object ()
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
KzuTaskSchedulergetTaskScheduler () const
 Returns the task scheduler of the object. More...
 
KzuMessageDispatchergetMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object. More...
 
virtual const MetaclassgetDynamicMetaclass () const KZ_OVERRIDE
 Returns the metaclass of the dynamic type of the object. More...
 
AppliedStyleEntrySharedPtr applyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object. More...
 
void unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
 
void applyObjectStyles ()
 Apply all styles for an object node. More...
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles. More...
 
- Public Member Functions inherited from kanzi::MetaObject
virtual ~MetaObject ()
 
bool isTypeOf (const Metaclass *objectType) const
 Determines if the type of this object is the given type or derived from it. More...
 
- Public Member Functions inherited from kanzi::PropertyObject
 PropertyObject ()
 
virtual ~PropertyObject ()
 
template<typename DataType >
void setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 Sets the local value of a property. More...
 
void removeKzbProperties ()
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property. More...
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalProperty (const PropertyType< DataType > &propertyType) const
 Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers. More...
 
template<typename DataType >
void setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
void setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
bool isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
 
void clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value. More...
 
bool hasBaseValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value, disregarding modifiers. More...
 
bool hasLocalValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a local value set for the property. More...
 
bool hasNonClassValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a value of any precedence higher than class default value set for the property. More...
 
void removeLocalValue (AbstractPropertyType propertyType)
 Removes the local value associated with the property. More...
 
void copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
 Copies local value of single property from another object. More...
 
void copyLocalValues (const PropertyObject &other)
 Copies all local values from another object. More...
 
virtual void onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
 Virtual function to handle property change notifications. More...
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *owner)
 
template<typename DataType >
void removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *owner)
 
template<typename DataType >
void addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
void validatePropertyModifiers (AbstractPropertyType propertyType)
 
template<typename DataType >
void addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
size_t getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType)
 Gets number of current notification handlers for given property type. More...
 

Static Public Member Functions

static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
static PinchManipulatorSharedPtr create (Domain *domain, string_view="")
 
- Static Public Member Functions inherited from kanzi::Object
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 
- Static Public Member Functions inherited from kanzi::MetaObject
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 

Public Attributes

float m_scaleThreshold
 Scale threshold. More...
 
float m_rotateThreshold
 Rotate threshold. More...
 
unsigned int m_touchIdA
 First touch ID. More...
 
unsigned int m_touchIdB
 Second touch ID. More...
 
bool m_scaling
 Is scaling. More...
 
bool m_rotating
 Is rotating. More...
 
Vector2 m_normalizedReferenceVector
 Reference direction vector for the difference between the touch points. More...
 
float m_referenceScale
 Reference scale of the difference between the touch points. More...
 

Static Public Attributes

static MessageType< StartedMessageArgumentsStartedMessage
 Message type for notifying start of the pinch gesture. More...
 
static MessageType< MovedMessageArgumentsMovedMessage
 Message type for notifying scale and rotation updates during pinch gesture. More...
 
static MessageType< FinishedMessageArgumentsFinishedMessage
 Message type for notifying completion of the pinch gesture. More...
 

Protected Member Functions

 PinchManipulator (Domain *domain)
 Constructor. More...
 
virtual void notifyTouchInside (const TouchInfo &touchInfo) KZ_OVERRIDE
 Touch inside implementation for pinch manipulator. More...
 
virtual void notifyTouchOutside (const TouchInfo &touchInfo) KZ_OVERRIDE
 Touch outside implementation for pinch manipulator. More...
 
virtual void onReset () KZ_OVERRIDE
 Reset implementation for pinch input manipulator. More...
 
void trackPinch (const TouchInfo &touchInfo)
 Update the state of the pinch gesture with the new touch event. More...
 
- Protected Member Functions inherited from kanzi::InputManipulator
 InputManipulator (Domain *domain)
 Constructor. More...
 
virtual void onAttach ()
 Attach function for input manipulators. More...
 
virtual void onDetach ()
 Detach function for input manipulators. More...
 
virtual void onCancel ()
 Cancel function for input manipulators. More...
 
virtual void onFail ()
 Fail function for input manipulators. More...
 
void addHitTestArguments (MessageArguments &message, const KzuInputTouchPoint &touchPoint)
 Add hit test information arguments to the message from the touch point. More...
 
- Protected Member Functions inherited from kanzi::Object
void initialize ()
 
void onCopy (const Object &other)
 
- Protected Member Functions inherited from kanzi::MetaObject
 MetaObject ()
 
void initialize ()
 
- Protected Member Functions inherited from kanzi::PropertyObject
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *owner)
 
void removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
 
AbstractPropertyTypeDescriptor::ValueSourceEntrygetTopValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) const
 
AbstractPropertyTypeDescriptor::ValueSourceEntrygetTopValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourceEntryfindLocalValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
PropertyStoragePtr findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
 Gets property storage intrusive pointer that can be used to hold a reference until end of operation. More...
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
PropertyStoragePtr acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType)
 
void validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
 Copy local value from property storage. More...
 
PropertyStorageContainer::iterator beginPropertyStorage ()
 
PropertyStorageContainer::iterator endPropertyStorage ()
 
virtual void notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)
 
void onCopy (const PropertyObject &other)
 

Additional Inherited Members

- Public Types inherited from kanzi::InputManipulator
enum  State {
  StateReady, StatePossible, StateBegin, StateChange,
  StateEnd, StateFail, StateDelayed, StateCanceled
}
 Enumeration for possible input manipulator states during touch or mouse input sequence. More...
 
enum  TouchEventRoutingMode { RoutingBubbling, RoutingTunneling }
 Enumeration for the available touch event routing modes. More...
 
typedef vector< KzuInputTouchPoint * > TouchPointsContainer
 
typedef TouchPointsContainer::const_iterator TouchPointsConstIterator
 
- Public Types inherited from kanzi::PropertyObject
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef vector< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef PropertyStorageContainer::const_iterator PropertyStorageConstIterator
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 
- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container. More...
 
- Static Protected Member Functions inherited from kanzi::InputManipulator
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 

Detailed Description

Pinch input manipulator recognizes the pinch gesture from incoming touch events.

It generates the required messages to implement the logic for objects which react to the pinch gesture. For example, use the pinch input manipulator to zoom in or zoom out a map using the pinch gesture.

See also
ClickManipulator, DragAndDropManipulator, LongPressManipulator, MultiClickManipulator, PanManipulator

Examples:

To receive the pinch update events, add message handler for the MovedMessage message.

First create a handler method:

void onPinchMoved(PinchManipulator::MovedMessageArguments& /*messageArguments*/)
{
// Insert your code to handle the pinch moved event here
}

Then add a message handler for your node:

node->addInputManipulator(pinchManipulator);
movedMessageSubscription = node->addMessageHandler(PinchManipulator::MovedMessage, bind(&InputManipulatorSnippet::onPinchMoved, this, placeholders::_1));

Constructor & Destructor Documentation

kanzi::PinchManipulator::PinchManipulator ( Domain domain)
explicitprotected

Constructor.

Member Function Documentation

static PropertyTypeEditorInfoSharedPtr kanzi::PinchManipulator::makeEditorInfo ( )
static
static PinchManipulatorSharedPtr kanzi::PinchManipulator::create ( Domain domain,
string_view  = "" 
)
inlinestatic
void kanzi::PinchManipulator::setScaleRecognitionThreshold ( float  threshold)

Set the threshold the fingers have to move away from each other before scale is recognized. The default value is 5 screen units.

void kanzi::PinchManipulator::setRotationRecognitionThreshold ( float  threshold)

Set the threshold the fingers have to rotate around the midpoint before rotation is recognized. The default value is 5 screen units along the circle.

virtual void kanzi::PinchManipulator::notifyTouchInside ( const TouchInfo touchInfo)
protectedvirtual

Touch inside implementation for pinch manipulator.

Reimplemented from kanzi::InputManipulator.

virtual void kanzi::PinchManipulator::notifyTouchOutside ( const TouchInfo touchInfo)
protectedvirtual

Touch outside implementation for pinch manipulator.

Reimplemented from kanzi::InputManipulator.

virtual void kanzi::PinchManipulator::onReset ( )
protectedvirtual

Reset implementation for pinch input manipulator.

Reimplemented from kanzi::InputManipulator.

void kanzi::PinchManipulator::trackPinch ( const TouchInfo touchInfo)
protected

Update the state of the pinch gesture with the new touch event.

Member Data Documentation

MessageType<StartedMessageArguments> kanzi::PinchManipulator::StartedMessage
static

Message type for notifying start of the pinch gesture.

StartedMessage is generated when touch is pressed or arrives to the attached node area.

MessageType<MovedMessageArguments> kanzi::PinchManipulator::MovedMessage
static

Message type for notifying scale and rotation updates during pinch gesture.

MovedMessage is sent first when the scale or rotation threshold is exceeded and after that when the tracked touches have moved between updates.

MessageType<FinishedMessageArguments> kanzi::PinchManipulator::FinishedMessage
static

Message type for notifying completion of the pinch gesture.

FinishedMessage is sent when the tracked touches are released or the gesture is canceled.

float kanzi::PinchManipulator::m_scaleThreshold

Scale threshold.

float kanzi::PinchManipulator::m_rotateThreshold

Rotate threshold.

unsigned int kanzi::PinchManipulator::m_touchIdA

First touch ID.

unsigned int kanzi::PinchManipulator::m_touchIdB

Second touch ID.

bool kanzi::PinchManipulator::m_scaling

Is scaling.

bool kanzi::PinchManipulator::m_rotating

Is rotating.

Vector2 kanzi::PinchManipulator::m_normalizedReferenceVector

Reference direction vector for the difference between the touch points.

float kanzi::PinchManipulator::m_referenceScale

Reference scale of the difference between the touch points.


The documentation for this class was generated from the following file: